-
Notifications
You must be signed in to change notification settings - Fork 22
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
fix: Add deprecation warning for CA #1244
base: main
Are you sure you want to change the base?
fix: Add deprecation warning for CA #1244
Conversation
when the resulting list becomes empty, just completely skip the "Dedicated OCM repository types"
ocm.CommonTransportFormat instead
If I execute, for example, Command "componentarchive" is deprecated, Deprecated - use CommonTransportFormat instead But Edit: it is a command. Though the message looks strange, we'll likely have to live with it. |
Was it really part of #1244, to directly remove all mentions of component archive from the reference? I thought, for now we only wanted to put a disclaimer with a warning. But I'm not against removing it. I find it a bit inconsistent, but, on the other hand, maybe it is a good motivation for existing user to start thinking of switching to CTF. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please see my other comments.
One more place to deprecate:
|
Cobra-commands do actually have a field, where you can write a string to, marking commands as deprecated. See: https://github.com/hilmarf/ocm/blob/deprecate/ComponentArchive/cmds/ocm/commands/ocmcmds/componentarchive/cmd.go#L24 |
You're right, it's not written as requirement to remove all mentions of component archive. But I don't like to read through anyhow too large documentation and then need to let my brain filter out everything which is deprecated. @morri-son what's your take on that? Shall we still generate all the documentation around CAs or not? |
thanks - good catch! I obviously missed to search for |
@hilmarf, Commands
So far those commands are not covered by this PR, if I see it correctly, right? There may be also other commands like this, which I'm not aware of. |
A separate question is, if we remove all information about component archives, do we already have enough documentation on how to achieve the same result with CTF? |
yes, that's right - #1254 is the follow up task to be done... or we are faster with the rewrite and skip it ;-) |
I don't know. I'm not using CAs. |
as mentioned above there are some commands that only work with CAs, but personally I also never used CAs, but only CTFs and think there is enough documentation on using CTFs + component constructors. Only in case someone manually creates components step by step using resource files, he may stumble into this issue. Looking at the documentation these cases are more to explain how to build a component and its different artifacts step by step, not a use case for pipelines. |
@morri-son , please check #1244 (comment) As you see, @hilmarf suggests to remove documentation for
|
I can only share my point of view :-) I do not see a benefit in mentioning CAs anywhere in the docs anymore when we're about to discontinue support for them soon. We will keep it in the code for own purposes, e.g. debugging, but we want to shift end users to CTFs already right now. Therefore I would also remove |
What this PR does / why we need it
we don't want to support component archives (CA) anymore
Which issue(s) this PR fixes
fixes: #1242
potential follow up: #1254